Arrow Resilience Kit/[root]/CircuitBreaker

CircuitBreaker

JS/TS-friendly facade over com.sorinirmies.arrow.resiliencekit.CircuitBreaker.

import { CircuitBreaker } from "arrow-resilience-kit";

const breaker = await CircuitBreaker.create({ failureThreshold: 5, resetTimeoutMillis: 30_000 });
const result = await breaker.execute(() => callExternalService());

Types

Companion

object Companion

Functions

currentState

fun currentState(): Promise<String>

Current state: "Closed", "Open", or "HalfOpen".

execute

fun <T> execute(block: () -> Promise<T>): Promise<T>

Executes block through the circuit breaker. Rejects with an error if the circuit is open.

executeOrFallback

fun <T> executeOrFallback(fallback: () -> Promise<T>, block: () -> Promise<T>): Promise<T>

Executes block, falling back to fallback if the circuit is open.

failures

fun failures(): Promise<Int>

Current consecutive-failure count.

onStateChange

fun onStateChange(listener: (oldState: String, newState: String) -> Unit)

Registers listener to be called (with the old and new state names) on every state change.

reset

fun reset(): Promise<Unit>

Manually resets the circuit breaker to closed state.

successes

fun successes(): Promise<Int>

Current half-open success count.

trip

fun trip(): Promise<Unit>

Manually opens the circuit breaker.